Skip to main content
POST
/
v1
/
analyses
/
{analysis_id}
/
run
/
subset
Run specific sub-analyses by ID [STUB]
curl --request POST \
  --url https://api.example.com/v1/analyses/{analysis_id}/run/subset \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "sub_analysis_ids": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": "<string>",
    "status_url": "<string>"
  },
  "response_type": "RunAcceptedResponse",
  "links": []
}

Authorizations

X-API-Key
string
header
required

API Key for external integrations (format: greetincs_...)

Path Parameters

analysis_id
string
required

Analysis ID in TypeID format

Body

application/json

Request schema for running specific sub-analyses.

sub_analysis_ids
string[]
required

List of sub-analysis IDs to run

Minimum array length: 1

Response

Successful Response

Response for run endpoints indicating processing has been accepted.

data
RunAcceptedData · object
required

Minimal data for accepted run operations.

response_type
string
default:RunAcceptedResponse

HATEOAS links related to this response (e.g., self, next, prev)

Example:
[
{
"href": "/resource/{resource_id}",
"method": "GET",
"rel": "self",
"title": "Resource Details"
},
{
"href": "/resource/{resource_id}/related",
"method": "GET",
"rel": "related",
"title": "Related Resources"
}
]